Skip to main content

Find all tenants with basic public information

GET /api/v1/tenants/basic/public

Description​

Find all tenants with basic public information.

Request​

  • URL:

    • Raw URL: /api/v1/tenants/basic/public?fieldNames=&tenantDateRange=&tenantByIds=&tenantSearch=&order=DESC&limit=

    • Host:

    • Path: /api/v1/tenants/basic/public

    • Query Parameters:

      • fieldNames: Allowed fields separated by comma (e.g., name, code, email, photo, address, phone)

      • tenantDateRange: Date range (e.g., 2020-11-12,2022-11-15)

      • tenantByIds: Tenant IDs

      • tenantSearch: Tenant search

      • order: DESC

      • limit: Limit

Response:

  • Status: OK (200)
/api/v1/tenants/basic/public?fieldNames=<string>&tenantDateRange=<string>&tenantByIds=<string>&tenantSearch=<string>&order=DESC&limit=<string>

Query Params​

Paramvalue
fieldNamesstring
tenantDateRangestring
tenantByIdsstring
tenantSearchstring
orderDESC
limitstring

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/tenants/basic/public \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!